home *** CD-ROM | disk | FTP | other *** search
/ Amiga Collections: Amiga Amateur Radio User Group / AARUG UK #01 (1989-10)(Amiga Amateur Radio User Group UK)(PD)[m].zip / AARUG UK #01 (1989-10)(Amiga Amateur Radio User Group UK)(PD)[m].adf / UtiliMaster.DOC / UtiliMaster.DOC
Text File  |  1993-12-02  |  16KB  |  355 lines

  1.  
  2.  
  3.         UtiliMaster
  4.  
  5.     Programable buttons!
  6.     ARC Won't hang up on duplicate files!
  7.     Two windows (Source & Destination)!
  8.     Modify "Standard" buttons!
  9.     Icon doubles as configuration file!
  10.     Run from Workbench or CLI!
  11.  
  12.     The top display window is ALLWAYS the source, the bottom
  13.         destination. The box above each display shows the current
  14.         directory being displayed. The three boxes in the lower
  15.         right are the Entry ("E") box, the source directory Disk
  16.         or Device name, and the destination directory Disk or
  17.         Device name. Swapping a disk while it's directory is
  18.     being displayed will automatically get the parent
  19.     directory of the new disk in the appropriate window.
  20.  
  21.     To move into a sub-directory, "Double-Click" it's name. 
  22.     (The time between two clicks to be considered double-clicking
  23.     is determined by Preferences.) To move to the parent of
  24.     the current directory, Double-Click the directory name
  25.     box (Above the list window). Double-Clicking the root
  26.     directory will cause Utilimaster to get it from the device
  27.     again. (This is useful if something outside Utilimaster
  28.     has changed you directory listing.)
  29.     If a symbol like a capital Y with a line thru it appears
  30.     just to the left of the filesize, that file is protected
  31.     to some state other than "rwed". If a C in a circle
  32.     appears, the file has a comment attached to it.
  33.  
  34.     Standard buttons:
  35.  
  36.     "Swap" Will swap the source and destination directories. Files
  37.         may not be selected in the destination window other than
  38.         Double-Clicking sub-directories. If source and
  39.         destination are swapped, selected files are not
  40.         highlighted in the destination window, but will
  41.         be remembered and highlighted in the source window
  42.         if directories are swapped back.
  43.  
  44.     "All" Selects all files in source directory.
  45.     "AllDirs" Selects all sub-directories in source directory.
  46.     "Exchange" De-selects all selected and selects all unselected.
  47.     "ExcDirs" Same for directories.
  48.     "Clear" De-selects all selected files.
  49.     "ClrDirs" Same for directories.
  50.     "Copy" Copies all selected files and sub-directories (including
  51.         files in sub-directories) to destination directory.
  52.         Copy also copies file comments, and if NOLOCK=1 has
  53.         not been entered as a tooltype in the icon, protection
  54.         on the copy is set to the same as the orriginal. (If
  55.         protection on the orriginal is "r-e-" then the copy is
  56.         set to "r-e-".)
  57.         If you enter a FileName in the "E" box, and copy
  58.         a file, it will be renamed in the destination directory.
  59.         In this case, copy stops after the first FileName if
  60.         more than one is selected.
  61.     "Rename" Will rename the FIRST selected file or directory to
  62.         the name in the "E"(Entry) box. If no name appears
  63.         in the "E" box, a requester appears requesting the 
  64.         new file name.
  65.     "Move" If destination directory is on the same device as source,
  66.             selected files will be moved into destination directory.
  67.             If not on the same device, an error message is displayed.
  68.     "Delete" Will present a requester asking if you are sure. Given
  69.         an affirmative, it will delete selected files. Selected
  70.         directories will be automatically deleted if empty.
  71.         For directories containing files, a requester appears
  72.         to remind you if they are not empty. Given an OK,
  73.         these directories, and all files and sub-directories
  74.         will be deleted. Empty directories are deleted with-
  75.         out any requester. (The theory is that an empty
  76.         directory is easy to re-create.)
  77.     "Lock" Changes the protection on selected files/directories to
  78.         "r-e-". They are protected from being written to or
  79.         deleted. Lock will protect all files in selected
  80.         directories. Lock fails if there is a system file-
  81.         lock on a file or directory. If a particular directory
  82.         repeatedly fails to lock, it may have something "assigned"
  83.         to it, or may be part of the "path" list.
  84.     "UnLock" Changes protection to "rwed".
  85.     "Read" Displays the selected file(s) to the screen. ASCII files
  86.         are displayed in text mode, binary etc. are displayed
  87.         as if "c:type opt h" were used, except that the decimal
  88.         file position is listed on the right side of the screen.
  89.         The Up & Down arrows, or scrollbar may be used to move
  90.         forward or backward thru the file. The window-close
  91.         gadget exits read. For keyboard instructions, select
  92.         a file, click "Read", and once the file is displayed,
  93.         push the "HELP" key. The choice of modes is based on
  94.         whether any 0 bytes are found. (ASCII text files
  95.         SHOULD NOT contain any 0 bytes!)
  96.     "FileNote" Attaches whatever is in the "E" box (Even a null
  97.         string!) as a comment to each selected file REPLACING
  98.         any existing comment. Using FileNote with the "E" box
  99.         empty will delete any existing comment.
  100.     "GetNote" Displays the comment on selected file(s) in the
  101.         Status box and the Filename in the "E" box. There is
  102.         a brief delay built in so you have a chance to read
  103.         them if more than one file is selected. Note that
  104.         commented files display a c in a circle just to the
  105.         left of their size in the display window.
  106.     "Print" By default, if Utilimaster can find a file named
  107.         "c:print" it will be RUN and passed the filename, if
  108.         not, an internal routine will print the file to PRT:.
  109.         The default external print routine can be changed.
  110.         See "Setting Defaults", below.
  111.     "Show" By default uses "c:show" to display the selected file(s).
  112.         Show can also be re-defined.
  113.     "Search" By default opens a window and calls "c:search" passing
  114.         it the content of the "E" box as the string to seek,
  115.         and selected file(s) to search.
  116.     "Arc" "DeArc" & "ListArc" by default all use "c:arc".
  117.             "Arc" opens a window and Executes
  118.            "c:Arc a Filename <FileName> <FileName>" for selected
  119.            file(s).
  120.     "DeArc" Opens an interactive window and Executes
  121.            "c:Arc x FileName".  If duplicate files are found,
  122.            this version of UtiliMaster DOES NOT lock up in
  123.            the endless loop most others do!
  124.     "ListArc" Opens a window and Executes
  125.            "c:arc v FileName" The window remains open for
  126.         reading until you close it.
  127.     "Run" Is equivelant to typing "run > nil: FileName" from CLI.
  128.         No window is opened for your file by UtiliMaster.
  129.     "Edit" Defaults to "run e FileName"
  130.     "Execute" Defaults to "Execute FileName"
  131.     "GetDir" Gets the directory in the "E" box, which MUST begin
  132.         with a device name. If the "E" box is empty, the current
  133.         source directory is up-dated. Usefull if you have added
  134.         or deleted a file from some other program.
  135.         To get a sub-directory in a window, Double-Click on that
  136.         directory's name. To get the parent of any displayed
  137.         sub-directory, Double-Click on the Directory
  138.         name box at the top of the listing window.
  139.     "MakeDir" Will make a directory with the name in the "E" window.
  140.         If nothing appears in the "E" window, a requester appears.
  141.         If MakeDir was clicked with the LEFT button, the
  142.         directory will be created in the source directory.
  143.         If the RIGHT button was used, the new directory goes
  144.         in the destination.
  145.     "Info" Displays the number of USABLE bytes free on each device
  146.         in the window where the device name usually appears.
  147.         (Or free memory in the case of the Ram Disk) If any
  148.         files (NOT directories!) are selected, their total bytes
  149.         and number of x-modem blocks is disp[layed in the status
  150.         window.
  151.     "NewCLI" Will start up a new CLI if Utilimaster can find
  152.         "c:NewCLI". If a filename is selected the result is
  153.         "NewCLI from filename".
  154.  
  155.     All of the "Device" (DF0: DF1: RAM: etc.) buttons may be
  156.         clicked with the LEFT mouse button to get the device
  157.         as the SOURCE directory, or with the RIGHT mouse button
  158.         to get it as the DESTINATION directory. All of these may
  159.         be re-programed to get other devices in the following
  160.         manner:
  161.  
  162.         To change "VD0:" to "VDK:", select (SINGLE-Click) the
  163.         Utilimaster icon on the workbench screen. Select "Info"
  164.         from the workbench menu. Click the "ADD" box next to
  165.         the "ToolTypes" window. Click in the "ToolTypes" box
  166.         and type "VD0:=VDK:" Please note that "VD0:" MUST be
  167.         upper case, but "vdk:" may be lower case if you so
  168.         desire. If you want other text in the button for the
  169.         device, leave a space and enter up to 8 characters.
  170.         EXAMPLE: To change "SYS:" to call your "s:" directory
  171.         with the button lbeled "Scripts" add a tooltype line
  172.         which says "SYS:=s: Scripts"
  173.         EXAMPLE: To change "DH1:" to call up the directory
  174.         "SYS:MyFiles" and the button to display "All Mine"
  175.         add a tooltypes line of "DH1:=sys:myfiles "All Mine"".
  176.         Note that "All Mine" should be entered in the tooltypes
  177.         box in quotes!
  178.  
  179.     Each time UtiliMaster is started (whether from workbench or CLI!)
  180.         the icon is parsed for these settings as well as those
  181.         described below.
  182.  
  183.     UtiliMaster defaults to "SYS:" as the source, and "RAM:" as the
  184.         destination directories on startup. You can change this
  185.         by adding a tooltype line that says
  186.         "DEFAULT=Directory Directory". The first directory
  187.         listed will become the default source, the second
  188.         will become the destination. If only one directory
  189.         name is entered, only SYS: will be changed.
  190.  
  191.     UtiliMaster allows you to dictate a command directory other than
  192.         "c:" To do so add a tooltype line
  193.         "COMMAND=DirectoryName". If the directory does not
  194.         exist, Utilimaster will attempt to create it. Utili-
  195.         Master will then attempt to copy "c:run","c:newcli",
  196.         "c:endcli","c:execute",and "c:assign" into this
  197.         directory. It will then attempt to "assign c: 
  198.         DirectoryName". (This is due to the fact that the
  199.         DOS Execute() command invokes "c:run" in order to
  200.         function. The manx "exec()" commands don't need
  201.         "c:run", but won't function within a program started
  202.         from WorkBench!. They've got us between a rock and a
  203.         hard place!)
  204.         On exiting UtiliMaster, "c:" will be assigned to
  205.         "SYS:c" unless you specify elswhere by a tooltype
  206.         "REASSIGN=DirectoryName".
  207.         If Utilimaster created a new command directory,
  208.         it will be deleted. If you assigned command to
  209.         an existing directory, it will be left intact on
  210.         exiting UtiliMaster. (Including any files
  211.         UtiliMaster copied into it!)
  212.             Other utilities may be copied into your newly
  213.         created command directory via a tooltype
  214.         "COPYLIST=FileName FileName FileName (etc.)". All
  215.         FileNames should include the Device:.
  216.  
  217.     There are four more buttons which do not appear unless defined
  218.         by the user as described below.
  219.  
  220.     USER BUTTONS: (Including changes to Show, Print, Arc,
  221.              Search, etc.)
  222.  
  223.     Each of the four user buttons is defined by a tooltype line.
  224.     "USER#=FileName ButtonText [flags] [Perameters] [PromptText]"
  225.     Where FileName is the FULL directory name of the program to
  226.      invoke.
  227.     ButtonText is the text (up to 8 characters) for the button.
  228.     Flags are desribed below.
  229.     Perameters (up to 8 characters) to pass to function).
  230.     PromptText (up to 30 characters) Is the Text to present in a
  231.       Requester if your program requires user input.
  232.          (Example: A fileName to create). If no promptext
  233.       is provided, no requester will appear.
  234.  
  235.     Flags:
  236.        If your program is simply to be run (Example "sys:Clock"),
  237.       then flags=0. (You need not enter Perameters or Promptext
  238.       unless you want them. If you DO use perameters, then flags
  239.       should be entered as 0. If promptext is entered you MUST
  240.       enter flags (even if 0) and perameters (even if "")).
  241.       To RUN your program with selected FileName(s) passed to your
  242.         program, add 1. The result is as if typing:
  243.             "run >nil: CommandName FileName" 
  244.         from CLI for EACH Selected File. If 1 is NOT added the result is
  245.         like typing:
  246.             "CommandName FileName" from CLI for each selected FileName.
  247.       To open a window for your program to output text (It thinks
  248.     it's running from CLI!) add 2.
  249.       To open a window from which your program can accept keyboard
  250.     input, add 4. DO NOT add 2 AND 4!
  251.       To have perameters passed BEFORE the FileName, enter
  252.     Perameters and add 8 to flags.
  253.       To have perameters passed AFTER the FileName, enter perameters
  254.     and add 16 to flags.
  255.       If you use an output only window (you added 2) and want the
  256.     window to close after each FileName has been passed, add 32.
  257.     Otherwise the window will remain open until you close it.
  258.       To exclude selected directories from being passed to your
  259.     program, add 64.
  260.       To run your program passing it only the current source
  261.     directory name, add 128. If you click the button with NO
  262.     filename selected, your program will be started as dictated
  263.     by the other flags but passed the string appearing in the
  264.     source directory window instead of a full filename.
  265.       The number entered for "Flags" should be a total of the above
  266.     depending on what you want to happen.
  267.     EXAMPLES:
  268.       If Flags=0 Then the result of clicking the button will be like
  269.     typing "run > nil: CommandName" from CLI. Hence the tooltype
  270.       "USER1=sys:Clock Clock"  will cause the button for user1 to
  271.     read "Clock". When clicked it will RUN "sys:Clock", passing
  272.     nothing else to the program.
  273.       If Flags=65 your Program will not be invoked for any
  274.     directories, selected FileNames will be passed. Like 
  275.         "run >nil: Program FileName" from CLI.
  276.  
  277.     DEFAULT BUTTON SETTINGS:
  278.       Each of the buttons listed may be changed by a tooltypes line.
  279.       These examples show what that line would look like to obtain
  280.     exactly what the default setting for that button is.
  281.  
  282.     PRINT=c:Print Print 65
  283.       "c:Print" is RUN and passed a FileName. No directories are
  284.     allowed. Control is returned to UtiliMaster while "c:Print"
  285.     runs. If Utilimaster can't find  "c:print" (or whatever it's
  286.     been redefined to) an internal routine is used. Printer output
  287.     will be the same as screen format for "Read".
  288.  
  289.     SHOW=c:Show Show 64
  290.       "c:Show is started and passed a FileName. Directories are not
  291.       allowed. Control IS NOT passed back to Utilimaster until
  292.       "Show" is done. This is to prevent Show from being run
  293.       simultaniously for several files.
  294.     SEARCH=c:Search 50 all "What text?"
  295.       A window is opened, and the equivelant of typing
  296.         "c:Search FileName <"E" box content> All" takes place.
  297.       If the "E" box is empty, a requester appears whith the prompt
  298.       "What text?". The text then entered is substituted.
  299.     ARC=c:Arc Arc 0 A
  300.         Arc is a special case. Equivelent CLI line:
  301.           "c:Arc A FileName [FileName] [FileName]"
  302.     DEARC=c:Arc De-Arc 0 V
  303.         Arc is a special case. Equivelent CLI line:
  304.           "c:Arc X FileName"
  305.     LISTARC=c:Arc "List Arc" 0 V
  306.         Arc is a special case. Equivelent CLI line:
  307.           "c:Arc V FileName"
  308.     RUN=c:Run Run 64
  309.         Equivelent CLI line: "c:Run FileName"
  310.     EDIT=c:E Edit 1
  311.         Equivelent CLI line: "c:Run c:E FileName"
  312.     EXECUTE=c:Execute Execute 68
  313.         Equivelent CLI line: "c:Ececute FileName"
  314.     NEWCLI=c:NewCli "New CLI"
  315.         Equivelent CLI line: "c:Run c:Newcli"
  316.  
  317.     Please note that if a new command directory is defined, then
  318.     in each of the above examples, the new directory name will be
  319.     used in place of "c:".
  320.  
  321.     Also note that any of these may be told to look for the program
  322.     in some other directory. For example, if you keep "Newcli" in
  323.     your "System" directory, you would then use tooltype
  324.       "NEWCLI=System:Newcli "New CLI""
  325.       (Note the quotes around "New CLI" for the button. Utilimaster
  326.       understands quotes and any group of words/letters inside
  327.       quotes is treated as one perameter regardless of spaces.
  328.  
  329.     Occasionally an error will leave you with what amounts to a
  330.     CLI window opened. You escape this window with "Endcli"
  331.  
  332.     When run from workbench, Utilimaster opens a background window.
  333.     You may change it's size by tooltype
  334.       "WINDOW=CON:<Left>/<Top>/<Width>/<Height>/"
  335.     If you use this, window MUST be "CON:" and ALL FOUR dimensions
  336.     MUST be given! (Unless you LIKE Guru Errors!)
  337.     There are some programs (The version of "Arc" that I have, for
  338.     example.) which send some of their output to ERROR out instead
  339.     of STANDARD out. This output will go to the background window
  340.     if started from WorkBench or the CLI from which UtiliMaster was
  341.         started. Sorry, I haven't figured out a way around this. You may
  342.         see this output by using the "Window to Front/Back" gadgets.
  343.  
  344.         UtiliMaster is public domain software! (It's based on too
  345.         many predecessors!)
  346.  
  347.         Please send comments and/or sugestions (or contributions) to:
  348.                 John Scheib
  349.                 3805 FairWay Circle
  350.                 Las Vegas, Nevada 89108
  351.                 OR
  352.                 People Link: JSCHEIB
  353.  
  354.     Enjoy UtiliMaster!
  355.